home *** CD-ROM | disk | FTP | other *** search
/ Gamers Delight 2 / Gamers Delight 2.iso / Aminet / game / role / AMScen_0_9.lha / AMScen / README < prev    next >
Text File  |  1995-01-21  |  15KB  |  342 lines

  1.                 AmigaMUD
  2.  
  3.  
  4. This is pre-release version 0.9 of AmigaMUD. It replaces versions
  5. 0.5, 0.6 and 0.7, all of which have been uploaded to Aminet. Please
  6. feel free to distribute this pre-release as widely as possible. V0.8
  7. was not widely distributed. This is expected to be the last pre-
  8. release of AmigaMUD. I hope to do whatever bug fixes are needed, but
  9. no other changes, before turning this into the first non-beta release,
  10. V1.0.
  11.  
  12. At least one user, Nils-Arne Dahlberg, has solved all of the quests in
  13. the standard scenario, including the fairly difficult "Heart" quest.
  14. Any others out there managed this?
  15.  
  16. See the request for pictures and icons at the end of this file. I have
  17. yet to receive any of either, despite some good intentions out there.
  18.  
  19. Note that this is a BETA release. The system has been tested fairly
  20. extensively on a V2.04 A3000 (I run Enforcer continuously) and on a
  21. V1.3 A1000. Some testing was also done on a V1.3 A2500 and I am now
  22. developing and testing on a V3.1 A4000T. The MUD client has run on
  23. A500's, A1200's and a CDTV (with disk and keyboard).
  24.  
  25. This release is freely distributable - send it anywhere you like. You
  26. don't have to pay me anything, but I'm much more receptive to
  27. suggestions and requests that come with "donations", which can be sent
  28. to:
  29.  
  30.     Chris Gray
  31.     #808 - 8515 - 112 St.
  32.     Edmonton, AB
  33.     CANADA    T6G 1K7
  34.  
  35. Please do NOT send physical letters to me without donations if you
  36. want an answer. As many people who sent me letters about Draco and
  37. Amiga Empire will attest, I simply never get around to answering such
  38. letters. If the letter comes with, say, $50.00, however, I'll probably
  39. answer it right away, and perhaps even send you the latest version. I
  40. prefer to use electronic distribution means, however, since then I
  41. have fewer versions to keep track of.
  42.  
  43. I am much better at answering electronic mail, which can be sent to:
  44.  
  45.     cg@ami-cg.GraySage.Edmonton.AB.CA
  46.  
  47. I also read several Amiga and most MUD newsgroups. I hope to see lots
  48. of wildly enthusiastic articles about AmigaMUD! I suggest newsgroup
  49. comp.sys.amiga.games as the main discussion group, with perhaps some
  50. general MUD-related discussions in rec.games.mud.misc . A lot of the
  51. discussion on V0.5 was in newsgroup comp.sys.amiga.datacomm.
  52.  
  53.  
  54. This Release
  55.  
  56. There are 4 archives in this release. You only need the first one if
  57. you just want to play MUD on someone else's server. If you want to run
  58. a server, you will need the second one as well. If you want to create
  59. your own scenario, you will need all 4 archives.
  60.  
  61. The first archive, AMClnt-0.9.lha contains:
  62.  
  63.     README - this file
  64.     ChangesFromV0.5 - notes on what changed from the first version
  65.     ChangesFromV0.6 - much smaller list of changes for this version
  66.     ChangesFromV0.7 - changes between V0.7 and V0.9
  67.     mud.library - the shared library that clients and servers use
  68.     MUD - the actual client program
  69.     Intro.txt - introductory document - read this first
  70.     MUD.txt - how to run the MUD program
  71.     Playing.txt - tips and detailed information on playing within the
  72.     standard AmigaMUD scenario
  73.     Building.txt - how to do online building, both using commands and
  74.     using mouse-buttons
  75.     ToDo.txt - stuff left to do
  76.     birds - a sound sample that will be played occasionally. Place it
  77.     in AmigaMUD:Sounds/birds .
  78.     some icon files
  79.  
  80. The second archive, AMSrv-0.9.lha contains:
  81.  
  82.     MUDServ - the AmigaMUD server program
  83.     MUDAgent - the remote client agent program
  84.     MUDShut - the server shutdown program
  85.     MUDFlush - the server flush program
  86.     SMUD - the simple MUD client program
  87.     AgentKill - the Workbench-started agent killer program
  88.     MUDServ.txt - how to be a sysadmin
  89.     MUDAgent.txt - details on the agent program
  90.     SMUD.txt - the simple MUD local client program
  91.     Decisions.txt - some ramblings on possibilities
  92.     MUD.data - the database for the sample scenario
  93.     MUD.index - database index file for scenario
  94.     some icon files
  95.  
  96. The third archive, AMDoc-0.9.lha contains [this is all of the
  97.     programmer stuff in one archive; the previous release had this in
  98.     two parts]:
  99.  
  100.     MUDCre - the program used to create the initial database
  101.     Programming.txt - basic information on wizard mode, and on
  102.     programming in AmigaMUD
  103.     Builtins.txt - complete reference on all builtin functions
  104.     simple.m - the source to a simple scenario
  105.     ProgConcepts.txt - tutorial style documentation on writing
  106.     scenarios in AmigaMUD
  107.     Scenario.txt - tutorial/notes on programming within the standard
  108.     scenario, and on using parts of it in new scenarios
  109.  
  110. The fourth archive, AMScen-0.9.lha contains the complete source to the
  111.     standard scenario. Some extras are included this time.
  112.  
  113.  
  114. Quick Setup
  115.  
  116. The client will run just fine on a 512K Amiga with one floppy disk. To
  117. set up for such a situation, unpack the AMClnt-0.9.lha archive
  118. somewhere, setup a bootable floppy with at least 180K of space, copy
  119. the file "MUD" to somewhere accessible on it, and copy the file
  120. "mud.library" to the "libs" directory (the "libs:" assign location) on
  121. the floppy. The first copy can be done from Workbench by dragging the
  122. MUD icon to where you want it, and the second can be done by having
  123. booted from the floppy you want to install to, and double-clicking on
  124. the "CopyLib" icon.
  125.  
  126. If you have a hard drive, then you just need to unpack the AMClnt-0.9.
  127. lha archive wherever you want it, and then double click on "CopyLib".
  128.  
  129. The MUD program looks in location "AmigaMUD:" for any IFF pictures or
  130. sounds that the scenario requests. I haven't supplied many such since
  131. I don't have any. However, MUD will still try to find them. So, you
  132. need to have an assign of that name (or a partition or mounted floppy
  133. with that name) or you will be continually clicking "CANCEL" on the
  134. standard requester.
  135.  
  136. Installing the server is a bit harder, since it needs a bit more
  137. space. The server will run on a two-floppy 1.5 Meg V1.3 system (like
  138. my Amiga 1000), but more memory and a harddrive make things easier. I
  139. think more memory will be needed on a V2.0 system, but I'm not in a
  140. position to easily test that. The most space a server system needs is
  141. for the database files. They will nearly fill a single density floppy
  142. by themselves. To allow for this, the server program MUDServ can be
  143. told where to look for the files, so it does not have to be in the
  144. same place as the database files. To run on my A1000, I put the
  145. database files on one floppy, and the various AmigaMUD programs, etc.
  146. on a much trimmed down Workbench disk, in a directory called 'MUD'. I
  147. put a tooltype "PATH=DF1:" into the MUDServ icon, telling it where to
  148. find the database files, along with "CACHE=100000" and a stack size of
  149. 25000. I have "mud.library" in LIBS: on that floppy, and all of the
  150. programs (MUDServ, MUD, MUDFlush, MUDShut, AgentKill, MUDAgent) in the
  151. MUD directory.
  152.  
  153. On a harddrive, you can keep everything in one directory, but I
  154. suggest keeping the database files in one directory and the programs
  155. in another, so that it is easier to backup the database files. You
  156. will want to put a proper "PATH=" in the MUDServ icon, and a cache
  157. size suitable for your system. On my A4000T I use 500000, which
  158. results in very infrequent disk I/O once the system has settled down.
  159. I also have a "go" file which runs MUDServ from a shell, with
  160. appropriate parameters. It contains:
  161.  
  162.     run <path>/MUDServ >nil: <nil: -c500000
  163.  
  164. If you are not running the server locally, you can add tooltypes to
  165. the MUD icon that will point it at your modem (the default is the
  166. standard serial port, running at 19200 BPS), and you can put in a
  167. modem command to dial the server you will be calling. See MUD.txt for
  168. details. If you are running the server locally, you can put "LOCAL=
  169. TRUE" into MUD's icon, or just set variable "MUDLOCAL=TRUE" to tell
  170. MUD to connect to a local server instead of a remote one.
  171.  
  172.  
  173. Quick Running
  174.  
  175. To start MUD, just double-click on its icon, or, from a shell, type
  176. "MUD" or "run MUD" to start it up. It will initially open two windows,
  177. one for graphics and one for text. If it is doing a local connection,
  178. MUD will connect to the server, and you will be asked for your
  179. character name. If MUD is connecting remotely, the graphics window
  180. will go away, leaving a full-screen text window. In this phase, MUD is
  181. acting like a simple terminal program. Characters you type will be
  182. sent to the serial port (and modem), and characters received from the
  183. modem will be displayed on the screen. If you set up a modem command,
  184. it will be executed as soon as the window opens, so the first thing
  185. you see may be the dialing sequence. When you are connected to the
  186. remote system, you must arrange for it to let you have binary access
  187. to the MUD server. How this is done will depend on the remote system.
  188. If the remote system is not running a BBS or anything else, then the
  189. "MUDAgent" program may answer the phone, and you will have nothing to
  190. do to set up. Once the MUDAgent program is running on the remote host
  191. system, you should see a line saying:
  192.  
  193.     REMOTE END DETECTED
  194.  
  195. and the graphics window will come back. Shortly after that you should
  196. get a prompt for your character name. At this point you are using the
  197. AmigaMUD reliable protocol, and modem line noise will be hidden from
  198. you (unless it gets so bad that something gives up!)
  199.  
  200. When you are prompted for a character name, you should enter the name
  201. you wish to use for your MUD character. This name should not contain
  202. any spaces or punctuation marks. If this is the first time you have
  203. connected, then you may have to type in a "character creation
  204. password", depending on how the MUD administrator has set it up. It is
  205. also possible that you cannot create new characters, and will have to
  206. ask the MUD administrator to do it for you. If you are allowed to
  207. create a new character, then you will have to enter a password for
  208. that character, and then enter the same password again to verify that
  209. you typed what you thought you typed. This password should be known
  210. only to you, so that other people cannot connect to your MUD character
  211. and have it do or say things that you don't want it to have done or
  212. said. On later connections, you will only have to type in your
  213. password once (assuming you get it right).
  214.  
  215. It is possible that the host system is running software which cannot
  216. run the MUDAgent program in its reliable-protocol mode. In that case,
  217. you will only be able to connect to the AmigaMUD server there in text-
  218. only mode. You will not have graphics output, and you will not have
  219. mouse input. If that is the case, you will probably prefer to use a
  220. normal terminal program instead of the "MUD" program. AmigaMUD is much
  221. less interesting in text-only mode.
  222.  
  223.  
  224. What I Want From You
  225.  
  226. I want this stuff tested! In as many ways and circumstances as
  227. possible!
  228.  
  229. I want pictures! As you can readily tell, my talents as a graphics
  230. artist are close to non-existant. I have not attempted to draw any
  231. pictures for use in the scenario. The scenario, however, has been
  232. programmed to make use of some of them. I welcome submissions for
  233. these pictures. The pictures of locations must be 160 pixels wide by
  234. 100 pixels high using the following palette:
  235.  
  236.     0x000,    /* 00 - black */
  237.     0x777,    /* 01 - dark grey */
  238.     0x999,    /* 02 - medium grey */
  239.     0xccc,    /* 03 - light grey */
  240.     0xfff,    /* 04 - white */
  241.     0xd00,    /* 05 - brick red */
  242.     0xf00,    /* 06 - red */
  243.     0xf80,    /* 07 - red-orange */
  244.     0xf90,    /* 08 - orange */
  245.     0xfc0,    /* 09 - gold */
  246.     0xfd0,    /* 10 - cadmium yellow */
  247.     0xff0,    /* 11 - lemon yellow */
  248.     0xbf0,    /* 12 - lime green */
  249.     0x0f0,    /* 13 - green */
  250.     0x8e0,    /* 14 - light green */
  251.     0x2c0,    /* 15 - dark green */
  252.     0x0b1,    /* 16 - forest green */
  253.     0x0ca,    /* 17 - blue green */
  254.     0x0db,    /* 18 - aqua */
  255.     0x1fb,    /* 19 - light aqua */
  256.     0x6fe,    /* 20 - sky blue */
  257.     0x6ce,    /* 21 - light blue */
  258.     0x00f,    /* 22 - blue */
  259.     0x69f,    /* 23 - dark blue */
  260.     0xc1f,    /* 24 - violet */
  261.     0xc0e,    /* 25 - purple */
  262.     0xf1f,    /* 26 - magenta */
  263.     0xfac,    /* 27 - pink */
  264.     0xdb9,    /* 28 - tan */
  265.     0xc80,    /* 29 - brown */
  266.     0xa70,    /* 30 - medium brown */
  267.     0xa87    /* 31 - dark brown */
  268.  
  269. Currently, pen usage is as follows:
  270.  
  271.     0 - shows up in the borders, due to the Amiga hardware
  272.     1 - initial pen, button letter background, button highlighted letters
  273.     2 - button outer border
  274.     3 - button middle border
  275.     4 - default icon pen, button inner border
  276.     6 - default cursor pen
  277.     9 - button letter colour, button highlighted background colour
  278.     17, 18, 19 - normally used by the pointer (hardware sprite 0)
  279.  
  280. The pens used by the buttons can be changed, as can those for the cursor
  281. and the icons. (commands 'icon[s]' and 'cursor').
  282.  
  283. The scenario knows the names of the above set of colours. This is used
  284. for the above commands and in some of the building commands.
  285.  
  286. The following filenames can be IFF ILBM files in AmigaMUD:Images and
  287. will automatically be used instead of the generated graphics, if they
  288. are present on the client machine. I need any or all of these as nice
  289. images.
  290.  
  291.     bguild - the builder's guild
  292.     mall - the minimall
  293.     newsRoom - the newsRoom
  294.     pr_alley2 - north end of the alley, leading to the pasture
  295.     pr_alley4 - south end of the alley
  296.     pr_cavern - the big cavern with boulder in middle
  297.     pr_chamber - the chamber with building and lots of doors
  298.     pr_chamber5 - the goblin chamber
  299.     pr_chasm1 - the east chasm area
  300.     pr_chasm2 - the west chasm area
  301.     pr_crossroads - the crossroads
  302.     pr_doors2 - doors room before
  303.     pr_doors3 - doors room after
  304.     pr_entrance - the first Proving Grounds location
  305.     pr_forest2 - south of the hill
  306.     pr_forest6 - the northernmost stream location
  307.     pr_forest7 - north of the hill
  308.     pr_road2 - to the west of the crossroads
  309.     pr_tunnel57 - off to the goblin crawlways
  310.     pr_tunnelX4 - end of tunnel north of chasm
  311.     questRoom - Questor's office
  312.     securityDoor - just before the utility tunnel
  313.     sq_alcove - the entrance alcove
  314.     sq_ante - the entrance antechamber
  315.     sq_kitchen - the kitchen!
  316.     sq_valley1 - south end of valley
  317.     sq_valley12 - north end of valley
  318.     sq_valley13 - middle of valley, with tree
  319.     streets - the town streets
  320.     telegramOffice - the telegram office
  321.     utilityNorth - the north end of the utility tunnel
  322.     utilityPit - in the pit below the utility tunnel
  323.     utilitySouth - the south end of the utility tunnel
  324.     utilityStart - the start position in the utility tunnel
  325.     utilityTunnel - the in-between in the utility tunnel
  326.  
  327. Note that the newsroom and the telegram office are not present in the
  328. version of the database included here. Names starting with 'pr_' are
  329. in the Proving Grounds. Names starting with 'sq_' are in the squirrel
  330. area. If you make good images of any of these, just uuencode them and
  331. email them to me. If I include your picture in the next release, you
  332. will get credit for it.
  333.  
  334. I could also use some different icons, especially for the monsters in
  335. the Proving Grounds. All of them are 15 x 15 (leaving space between
  336. them) one-bit-per-pixel images. I need icons for:
  337.  
  338.     rat, snake, dog, gremlin, wolf, troll, black bear, deer, moose,
  339.     goblin, spider + larger varieties of many
  340.  
  341. Better version of the icons I already have would be fine, too.
  342.